/*
 * Copyright 2010 - 2011, The PLDesktop Development Team
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#ifndef PLEXCEPTION_H
#define PLEXCEPTION_H

#include <exception>
#include <kernel/PLAPIConfig.h>
#include <kernel/PLGlobal.h>

namespace PLSDK {

	/**
	 * Base class for all exceptions.
	 */
	class PLException : public std::exception {
	public:
		/**
		 * Empty Constructor.
		 */
		PLException();
		/**
		 * Constructor.
		 *
		 * @param what The message of the exception.
		 */
		PLException(const char *what);
		/**
		 * Destructor.
		 */
		virtual ~PLException();
		/**
		 * Set the text as new text for the exception.
		 *
		 * @param what The message of the exception.
		 */
		void setText(const char *what);
		/**
		 * Message function from c++.
		 *
		 * @return the C++ string message.
		 */
		virtual const char* what() const;
	private:
		mutable const char *m_text;
		PLDISABLE_COPY(PLException)
	};
	
}

#endif
